/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.queryablestate;

import java.util.concurrent.CompletableFuture;

/** Utility class for {@link java.util.concurrent.Future Java Futures}. */
public class FutureUtils {

    // ------------------------------------------------------------------------
    //  Future Completed with an exception.
    // ------------------------------------------------------------------------

    /**
     * Returns a {@link CompletableFuture} that has failed with the exception provided as argument.
     *
     * @param throwable the exception to fail the future with.
     * @return The failed future.
     */
    public static <T> CompletableFuture<T> getFailedFuture(Throwable throwable) {
        CompletableFuture<T> failedAttempt = new CompletableFuture<>();
        failedAttempt.completeExceptionally(throwable);
        return failedAttempt;
    }
}
